home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 6 / The Arsenal Files 6 (Arsenal Computer).ISO / tbbs / sysmdemo.exe / SYSMSTR.DOC < prev    next >
Text File  |  1996-02-10  |  23KB  |  545 lines

  1.                               SystemMaster
  2.           SystemMaster is (c) Copyright 1993, 1994, 1995, 1996
  3.                             By John Schachat
  4.  
  5.  
  6. About this Document:
  7.  
  8. This document will lead you through the various SM capabilities.  It is
  9. not intended, however, to be a TBBS, TDBS, DOS or Dbase primer.  Most of
  10. the functions in SM do not require you to be a Dbase expert. However,
  11. some do require TDBS/Dbase knowledge.  You may find that at times you
  12. will need to refer to your TBBS/TDBS manuals or to a Dbase Manual.
  13.  
  14.  
  15. About SystemMaster:
  16.  
  17. SystemMaster is an EXTREMELY flexible tool for any TBBS system.
  18. Through it's powerful Command Processors, Online Help and TDBS/DOS
  19. management functions, it covers all aspects of system use. With
  20. SystemMaster, there is no longer any need for a Sysop menu.
  21.  
  22. A Summary of SystemMaster Capabilities:
  23.  
  24. SystemMaster provides you with a large number of diverse capabilities.
  25. One of the most important of these is it's ability to to store and
  26. execute ANY TBBS command either individually or in a Program Group.
  27.  
  28. Individual Command Database:  From the Main menu, you can list/add/edit
  29. or delete individual commands.  Any command may be used, even a call to
  30. the QSO or TIMS OMs.  Enter it exactly as you would in SDL.  Once
  31. the command is stored in the database, it may then be selected for
  32. execution by entering it's number. Individual commands are always sorted
  33. in descending order by the last time they were used unless the <S>ort
  34. option is used.
  35.  
  36. Program Groups: This is an extension of the individual command database.
  37. Program Groups allow you to create a group of commands which are chained
  38. together so that they execute sequentially.  The execution start point
  39. may be anywhere in the chain depending on the command number you enter.
  40. If you want to skip over a command in the chain, delete it.  It will
  41. appear in red and will be skipped over when the chain executes. To add
  42. it back later, simply undelete it.  There is also a <T>imer function,
  43. which is a toggle.  When it is used, it will begin a clock when the
  44. command begins execution and stop it when the command completes.  This
  45. is useful for timing auto-executing TDBS modules, .BAT files or QALs.
  46.  
  47. The COMMAND PROCESSOR Side of the Main menu also contains a number of
  48. entries which allow you to maintain and modify the help database or to
  49. print it out.
  50.  
  51. The other parts of the main menu contain a wide variety of TDBS, DOS and
  52. Utility functions.
  53.  
  54. TDBS - This invokes a menu of TDBS commands which provide complete
  55. control over a DBF file or index.  Using these commands you may
  56. display the structure of a Database, Create or Modify a Database
  57. Structure, Append records into a database, import or export data using a
  58. comma delimited text file, Pack or ZAP a database, add/edit/delete
  59. records in a database, Create\Re-index NDX files, Search any Database,
  60. etc.
  61.  
  62. There is also a 'Database Manager' which allows you to store your most
  63. frequently used databases for fast retrieval.
  64.  
  65. To use these functions, either select a database manually or add an
  66. entry to the Database Manager.  Most functions then become available to
  67. you.
  68.  
  69. Utility functions - SystemMaster provides 'canned access' to most SYSOM
  70. functions.
  71.  
  72. File Editor allows you to create or edit any Text file, including FARS
  73. and PDIRS.
  74.  
  75. DOS FILE Utilities allow you to manipulate files, print them, read text
  76. files, search for files, etc.
  77.  
  78. Note: Some functions require that you have installed specific Option
  79. Modules, such as SYSOM, TIGER, TIMS, QSO, etc. If you try to invoke one
  80. of these commands, and the option module has not been installed, an
  81. error message will be retruned telling you that you tried an 'Invalid
  82. DOTBBS Type'.
  83.  
  84. Installation:
  85.  
  86. Put the contents of this package in its own subdirectory.  Keep the
  87. Subdirectory as close to the top of your directory structure as possible
  88. for maximum flexibility, such as C:\SM
  89.  
  90. Run the INSTALL.BAT utility.  It will create the GROUPS\ subdirectory
  91. and will copy the file TEMPLATE.DBF into it.
  92.  
  93. SDL and BounceBack Flags:
  94.  
  95. One of the most powerful things about SystemMaster is that it 'Bounces
  96. Back' to itself after executing ANYTHING.  This feature is enabled
  97. through the use of a flag and SDL entries.
  98.  
  99. To use this feature you must do the following:
  100.  
  101. 1. Select an UNUSED flag.  For this example we will use A4(5).
  102.  
  103. 2. Put the following in your SDL:
  104.  
  105.   Note: You will be adding 3 entries to the menu where SystemMaster is
  106.   located and also creating a Dummy menu.  These additional entries are
  107.   necessary to enable SystemMaster's BounceBack after commands are
  108.   executed.
  109.  
  110.   A. These 3 entries all go on the menu which calls SystemMaster and MUST
  111.      be in this order.  They consist of the actual menu entry which calls
  112.      SystemMaster and 2 autoexecutes which enable the BounceBack feature.
  113.  
  114.       ; SYSTEMMASTER MENU ENTRY
  115.       Entry: <S> SystemMaster
  116.       priv=255
  117.       Key=S Type=200 opt data=C:\SM\SYSMSTR /Q
  118.  
  119.       ; AUTOEXECUTE TO RETURN TO SYSTEMMASTER
  120.       Entry:
  121.       Priv=255
  122.       A1=--------
  123.       A2=--------
  124.       A3=--------
  125.       A4=----X---
  126.       Key=^@ Type=200 opt data=C:\SM\SYSMSTR /Q
  127.  
  128.       ; SYSTEMMASTER AUTOEXECUTE TO BOUNCE
  129.       Entry:
  130.       priv=255
  131.       a1=--------
  132.       a2=--------
  133.       a3=--------
  134.       A4=----X---
  135.       KEY=^@ TYPE=5 OPT DATA=SYSM
  136.  
  137.  
  138.   B. Now create a dummy menu in you SDL file.  It will only have 1 entry
  139.   and will be totally invisible (This is a necessary step! Don't leave
  140.   it out).  It should look like this:
  141.  
  142.       Menu: SYSM
  143.  
  144.       Entry: Autoexecute to return to the SystemMaster Menu
  145.       Key=^@
  146.       Type=12
  147.       OPT DATA=1
  148.  
  149.       Endmenu:
  150.  
  151. Note: Make ABSOLUTELY SURE that unauthorized users are not allowed
  152. access to SystemMaster, as it provides Complete Access to your entire
  153. system.
  154.  
  155. That's it.  There is one more installation step, however, which is done
  156. when you run SystemMaster.
  157.  
  158. 5. Now run SystemMaster and select option <Z> BounceBack Flags.  Enter the
  159. same flag that you selected previously, A4(5) in the example, and mark
  160. it with an 'X'. Like '----X---'.  All other Flag entries should just be
  161. dashes.
  162.  
  163. Installation is now complete.
  164.  
  165.  
  166. Reference Section:
  167.  
  168. For clarity we will describe the TBBS Command Processor functions first
  169. (left hand side of the menu) then proceed to the right hand side.
  170.  
  171. The Command Processors consist of 3 main functions:
  172.  
  173.  
  174. The Program Group Database
  175.  
  176. The Individual Command Database
  177.  
  178. The Help Database
  179.  
  180.  
  181. Program Groups:
  182.  
  183. A Program Group is a logical organization of TBBS commands which may be
  184. executed sequentially.  For example, let's say you have 3 TDBS programs
  185. which are inter-related and you want them to execute one right after the
  186. other.  Or you might have several TBBS commands which would execute in
  187. order.  An example of this would be:
  188.  
  189.  Execute a type 31 and change your profile to No Ansi/No graphics
  190.  
  191.  Execute a type 1 and view a file
  192.  
  193.  Execute a type 31 and change your profile to ANSI on and Graphics on
  194.  
  195.  Execute a type 1 and view the same file
  196.  
  197.  This would allow you to view the file as either type of user without
  198.  having to run around through your menus.  And since the commands all
  199.  execute sequentially, there is no interruption in the command chain.
  200.  
  201.  When a program group has completed, you will be returned to the command
  202.  listing within that program group.
  203.  
  204.  You may also time the execution speed of TDBS programs, QALS or
  205.  anything else by hitting the <T>imer key  This will provide you with a
  206.  time for each command in the program group you are executing.
  207.  
  208.  To use a Program Group, type <P> from the main menu.  You will see a
  209.  listing of available groups.  To see a listing of the contents of a
  210.  group and proceed type the number to it's left.  To Add a group, type
  211.  <A>
  212.  
  213.  Adding/Editing a Group:
  214.  
  215.  After typing <A> or <E> you will see a data entry screen with 3 fields.
  216.  
  217.  Group Name: The name of the Program Group that will appear on the
  218.  listing
  219.  
  220.  DBF Name: Each Program Group requires a special database which SM will
  221.  create.  This is stored in the GROUPS directory and must be unique.
  222.  Any Valid DOS name will suffice, without an extension.
  223.  
  224.  Comments: Any comments you wish to add.  These will also appear on the
  225.  listing.
  226.  
  227.  
  228.  Accessing a Group:
  229.  From the Main Program Group Listing, type the number of the group you
  230.  wish to access.  If there are any commands for that group you will see
  231.  them listed when the group is displayed, otherwise you may <E>dit\Add a
  232.  command.  If you are adding a command, leave the command # at 0,
  233.  otherwise enter the command # you wish to edit.
  234.  
  235.  Adding/Editing a Command:
  236.  Enter the TBBS Type for the command from 1-255.
  237.  Enter the appropriate Opt Data for that command.
  238.  Enter any Comments you'd like to appear on the listing.  These comments
  239.  may also be used as a sort key.
  240.  
  241.  You will notice that when you edit a command, automatic Help will be
  242.  displayed depending on the TBBS TYPE of that command.
  243.  
  244.  The Timer function is a toggle that turns on the program timer when a
  245.  program group begins execution.  The times you will see returned are
  246.  approximate and subject to system loading, processor and disk speed.
  247.  It is best to use this function with commands that do not require any
  248.  user input, as the timer will also record the 'wait' time.
  249.  
  250.  The Sort function allows you to sort the Program Group Command Database
  251.  either by the execution number or by the contents of the Comments
  252.  field.
  253.  
  254.  Executing a Program Group:
  255.  
  256.  Command execution may begin anywhere in the group.  If you have 10
  257.  entries and you type "5", execution will begin at command 5 and
  258.  proceed through Command 10.  If there are any deleted entries in the
  259.  program group, they will be skipped over as the group executes.
  260.  
  261.  The Program Group will always execute in sequential numerical order
  262.  regardless of the setting of the Sort toggle.
  263.  
  264.  Individual Commands:
  265.  
  266.  From the Main Menu, you may List the Individual Command Database, Go to
  267.  and run a specific Command, Add a Command, Delete a Command or Edit a
  268.  command.  By typing <L> you will see a listing of available commands
  269.  you have entered.  They are continuously sorted by when they were last
  270.  used, with the last used commands at the top of the listing.  From this
  271.  listing you may execute a Command by typing in it's number, Edit a
  272.  command, Add a new Command, or Delete a command.  <CR> will scroll the
  273.  screen if you have more than a single screen of commands.  The last
  274.  command that was run will always be at the top of the listing and will
  275.  also be displayed on the main menu. There is also an option to change
  276.  the way the database is sorted.  By hitting <S>, a toggle, the database
  277.  will either be sorted alphabetically by the Comments field or in
  278.  descending order by Date/Time.  The Comments Sort allows you to group
  279.  commands by the comments you add.  When a command is initially added, a
  280.  comment "~  No Comments" will be placed in the comments field.  This
  281.  may be changed, but if it is not, will place the command near the end
  282.  of an alphabetic comment sort.
  283.  
  284.  Index and Pack the Database:
  285.  
  286.  This command will reindex and Pack the SystemMaster Databases.
  287.  
  288.  Context Sensitive Help:
  289.  
  290.  This command will display HELP for the command that was last executed
  291.  and is currently being displayed on the main menu.
  292.  
  293.  Help System:
  294.  
  295.  The Help System provides Help for the various TBBS Command Types.  By
  296.  hitting <H> from the main menu you will be brought to a screen which
  297.  will allow you to List, Search, Add to or Modify the Help Database.
  298.  Although SM comes with a complete TBBS Command Database, you may modify
  299.  it or add any new commands as they become available.  It may also be
  300.  used to store non-TBBS information, QEMM settings for instance.  If you
  301.  do this, just remember to make sure that the Type is greater then 255.
  302.  
  303.  
  304.  Reference Card Builder/Printer:
  305.  
  306.  This allows you to build 'reference cards' based on the Help Database.
  307.  You have a variety of choices as to the type of reference card that
  308.  will be built as well as whether the output destination will be a text
  309.  file or a printer.  If you choose a printer, make sure it is hooked up
  310.  and turned on.
  311.  
  312.  Repeat Last Command:
  313.  
  314.  Many times in a testing cycle you will need to repetitively execute the
  315.  last command. By hitting the <CR> from the main menu, the last command
  316.  used, based on the date and time it was executed, will be run.
  317.  
  318.  
  319.  TDBS/DOS/Utility Functions:
  320.  
  321.  This section will first discuss the DOS and Utility Functions and end
  322.  with the TDBS commands.
  323.  
  324.  <S> SYSOM - Executing this command will bring you directly into SYSOM,
  325.  if that Option Module has been installed on your system.
  326.  
  327.  <V> View/Download/Search DOS Dirs - Prompts you for a file path and then
  328.  allows you to Search for a file, Examine an Archive or Download from
  329.  that directory.
  330.  
  331.  <M> Misc. System Info - Provides you with information about your system
  332.  including the available disk space on the disk where SM is located and
  333.  the total number of users currently executing any TDBS program on your
  334.  system.
  335.  
  336.  <U> Utility Functions - Provide you with easy access to most SYSOM
  337.  commands and allows you to run your own batch file.  Only for Systems
  338.  with SYSOM installed.  Also provides access to the TIMS control panel
  339.  (for systems with TIMS) and to QSO (for systems with QSO installed).
  340.  
  341.  <F> File Editor - This editor allows you to either place notes in a
  342.  database, that is associated with the current TBBS Command, or to edit
  343.  any text file on your system.  When you invoke this command you will be
  344.  in a full screen editor.  If you want to read in a file from your
  345.  system, type ^KR and enter in the complete path\name of the file to be
  346.  edited.  To type ^KR, depress the <CTRL> key and the <K> key at the
  347.  same time. Then release both and depress the <R> key.  After entering
  348.  the file information press ENTER and you will be able to edit the file.
  349.  When you are done, press ^KW, using the same key sequence as ^KR.
  350.  Again, you will be prompted for the file path\name where the file is to
  351.  be saved to.  If you wish to save notes to the database, just begin
  352.  typing or read in a text file, and when you're done, type ^W.
  353.  
  354.  <B> Batch Dos Upload - Simply specify the directory where the upload is
  355.  to be placed and then use your terminal emulator to begin a batch
  356.  upload using a batch protocol.
  357.  
  358.  <Y> DOS File Utilities - Use carefully!
  359.  
  360.      <C> Copy a File - Allows you to copy any DOS file by entering a
  361.      complete From\To specification.
  362.  
  363.      <D> Delete a File - Allows you delete any DOS file by entering a
  364.      complete file path\name.
  365.  
  366.      <R> Rename a file - Allows you to rename any DOS file by entering
  367.      the current DOS path\name and the new DOS path\name.
  368.  
  369.      <T> Text File reader - This is a custom reader with Back and Forth
  370.      scrolling and download capability.  It allows you to read any text
  371.      file on your system.  This reader also contains a 'Bookmark'
  372.      feature that allows you to <M>ark any page and then <G>o to it
  373.      later with a single keystroke.
  374.  
  375.      <P> Print a Text File - Allows you to print any text file to your
  376.      choice of printers, LPT1 - LPT4.
  377.  
  378.      <F> File Search and Information - Allows you to use wildcards to
  379.      search through your system for DOS files.  The listing will display
  380.      the DOS attributes for a file, the current size and the last
  381.      time/date that the file was modified.  Attributes are A=Archive,
  382.      R=Read Only, S=System, H=Hidden, D=Directory, V=Volume Label and
  383.      may appear in various combinations.  The search engine supports
  384.      both the "*" and "?" wildcards.
  385.  
  386.      <Z> Bounceback Flags - Discussed in the Installation Section.
  387.  
  388.      <Q> Quit - Returns you to the calling TBBS menu.
  389.  
  390.      <X> Exit - Logs you off immediately.
  391.  
  392. <T> TDBS Database Functions
  393.  
  394. Warning!  There are a number of extremely powerful commands in this
  395. section which, if misused, can cause serious damage to the database
  396. or Index you are working on. Also, some commands will grab a database
  397. for EXCLUSIVE USE.  This will prevent other users on the system from
  398. accessing it while you have it in use.
  399.  
  400. Most commands work on the database that is currently selected.
  401. Databases are selected either through the Database Manager <S> or
  402. by manually entering the path\name of the database you wish to work
  403. with <1>.
  404.  
  405. <S> The Database Manager Selector - SystemMaster allows you to keep a
  406. 'Database of Databases'. This lets you store the names and locations
  407. of databases that you use frequently.  To access this function, press
  408. <S> from the TDBS menu.  You will see a listing of stored databases.  At
  409. this point you may Select, Add, Edit, or Delete a database definition.
  410.  
  411.  Adding/Editing a Definition - You will be prompted for the path where
  412.  the .DBF and it's Index files are stored.  Enter the complete DOS path
  413.  without a trailing '\'.  Next, enter the .DBF name without the .DBF
  414.  extension. Add any comments that you want to appear in the listing.
  415.  
  416.  You will now be prompted for the names of any index files you wish to
  417.  have attached to this database when it is selected.  If you are using
  418.  index files, answer 'Y' to the prompt and enter the FULL name of the
  419.  index files.  This is necessary because index files may have extensions
  420.  other than .NDX.  The first entry will be the controlling index.  You
  421.  may not skip over any of the index fields, i.e. 1,2,3 is legal while
  422.  1,2,4 is not.
  423.  
  424.  To select a database from the listing, type <S> and the number of the
  425.  database you wish to select.  Once selected, you will be returned to
  426.  the Main TDBS menu.
  427.  
  428. After a database is Selected you may:
  429.  
  430. <L> Locate Information - This command allows you search for information
  431.     in any field in the database.  Fields that may be searched on are
  432.     Character, Numeric and Date.  The Character and Date Searches will
  433.     look for any record which CONTAINS the Search Argument.  The Numeric
  434.     search looks for an EXACT match.  Logical and Memo fields may not be
  435.     searched.  In addition, you may display a second field along with
  436.     the field you are searching for in any records that are found.  The
  437.     second field may be any type, including logical or memo.  In
  438.     addition to the 2 fields being displayed, the record number will
  439.     also be returned, allowing you to then edit the appropriate database
  440.     records using the Database Editor.
  441.  
  442. <E> Edit\Add\Delete - This Database Editor provides complete database
  443.     manipulation for the selected database on a record by record basis.
  444.  
  445. <Z> Zap - Will permanently Delete all records in the selected Database
  446.     and any attached indices. Be careful!
  447.  
  448. <C> Create/Recreate an Index - Allows you to build an NDX file based on
  449.     a field name you specify in the database that is currently selected.
  450.     You may also add a sort method.  For example, if you want to
  451.     create an index in descending order, you could specify the field
  452.     name as Descend(Field_Name).  Or if you wanted the index as all
  453.     upper case you would specify Upper(Field_Name).  You may also
  454.     concatenate fields by specifying Field1 + Field2.
  455.  
  456. <P> Pack - Will remove any deleted records from the selected Database
  457.     and any attached indices.
  458.  
  459. <V> View the Structure  - Displays the field layout of the selected
  460.     database.
  461.  
  462. <M> Modify the selected database structure - Allows you to add, delete
  463.     or change field definitions.  If no database is selected, a new
  464.     structure will be built, otherwise the selected database structure
  465.     will be modified.  A SEF file will be built as a result of this
  466.     operation and will be called TEMP.DBF  (SEF= Structure Extended
  467.     File).
  468.  
  469. <B> Build a New Database - Creates a new DBF from a SEF. If the SEF is
  470.     empty or one of the fields in the SEF has been improperly specified,
  471.     an error will result.
  472.  
  473. <A> Append Records - Allows you to add records to a new or existing DBF.
  474.     Only fields with the same name in both databases will be added.
  475.     Fields which are longer in the source database than the target
  476.     database will be truncated.
  477.  
  478. <I> Import Comma-delimited text - Allows you to specify a file which
  479.     contains comma-delimited text.  This file will be imported into the
  480.     selected database.
  481.  
  482. <O> Output Comma-delimited text - Will export the contents of the
  483.     selected database into a comma-delimited format text file.
  484.  
  485. <D> Data -  Displays the attributes of the current database.
  486.  
  487. <T> TDBS Error Messages -  A Database of all TDBS error messages which
  488.     may be listed or searched based on anything that is Contained in the
  489.     error message.
  490.  
  491.  
  492. Modifying an existing Database:
  493.  
  494.    1. Select the Database.
  495.    2. Use <M> Modify and modify/Add field definitions.
  496.    3. Use <B> Build to Create a new database from the SEF file that was
  497.    just created when you modified the database.  This will create a new
  498.    database with the new information you just added.
  499.    4. Use the <A> Append to add the information from the old database
  500.    into the new database.
  501.  
  502.    You will now have a new database, with the new field information you
  503.    added, that has all the information that was contained in the old
  504.    database.
  505.  
  506. Making a Quick Database Lookup Application:
  507.  
  508.    1. Make sure that no existing database is selected.
  509.    2. Use <M> Modify to build the Database structure.
  510.    3. Use <B> Build to Build the actual Database.
  511.    4. Use the Database Editor to add information to the Database.
  512.    5. Use the <L> ocate function to search on any information that was
  513.    added
  514.  
  515.                          ---> End of File <---
  516.  
  517.   =========================================================================
  518.  
  519.   If you are using the demonstration version of this program and would
  520.   like to have the full version please contact GW Associates for more
  521.   information.
  522.  
  523.                        GW Associates
  524.                        P.O. Box 6606,
  525.                        One Regency Drive,
  526.                        Holliston, MA  01746
  527.  
  528.                        BBS    (508) 429-8385 (Hayes 19.2)
  529.                        BBS    (508) 429-3118 (USR)
  530.                        Voice  (508) 429-6227
  531.                        FAX    (508) 429-3859
  532.  
  533.                        Telnet gwabbs.com
  534.                        FTP    gwabbs.com 
  535.                        WWW    http://www.gwabbs.com
  536.  
  537.    Registered GWA customers can order online by dialing 1-800-492-8327
  538.                                                               GWA-TDBS
  539.  
  540.   Call our BBS for access to over 200 of the top enhancement products
  541.   for TBBS/TDBS systems.  We originated the market for commercial third
  542.   party software and will always have the best available software to
  543.   offer to our customers.
  544.  
  545.